/*
 * The MIT License
 *
 * Copyright 2012 http://generic-toolset.googlecode.com.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.rlpw.swing;

import java.util.Comparator;
import java.util.List;

/**
 * Defines methods of components whose data are connected to the {@link org.rlpw.swing.Model}.
 * 
 * @param <T> the type of the elements
 */
public interface View<T> {

    /**
     * Updates the {@code View} based on the current {@code Model}.
     */
    public void updateView();

    /**
     * Returns the {@code Model} that provides the data displayed by this
     * {@code View}.
     *
     * @return the {@code Model} that provides the data displayed by this {@code View}
     * @see #setDataModel
     */
    public Model<T> getDataModel();

    /**
     * Sets the data model for this {@code View}.
     *
     * @param model the new data source for this {@code View}
     * @exception IllegalArgumentException if {@code model} is {@code null}
     * @see #getDataModel
     */
    public void setDataModel(Model<T> model);

    /**
     * Sets the {@code filter} for this {@code View}.
     * 
     * @param filter the {@code Filter}
     * @see #getFilter
     */
    public void setFilter(Filter<T> filter);

    /**
     * Returns the {@code Filter} of this {@code View}.
     * 
     * @return the {@code Filter}
     * @see #setFilter
     */
    public Filter<T> getFilter();

    /**
     * Sets the {@code Comparator} for this {@code View}.
     * 
     * @param comp the {@code Comparator}
     * @see #getSorter
     */
    public void setSorter(Comparator<T> comp);

    /**
     * Returns the {@code Comparator} of this {@code View}.
     * 
     * @return the {@code Comparator}
     * @see #setSorter
     */
    public Comparator<T> getSorter();

    /**
     * Returns a sorted list of all visible items based on the current {@code Filter} and {@code Comparator}. 
     * @return a sorted list of all visible items
     * @see #getFilter
     * @see #getSorter
     */
    public List<T> getVisibleItems();
}
